MarkLogic 12 Product Documentation
GET /manage/v2/hosts/{id|name}?view=configSummary
This resource address returns configuration information on a specific host. The
host can be identified either by id or name.
| URL Parameters |
| view |
A specific view of the returned data. Can be either
schema, status, metrics, or default. |
| format |
The format of the returned data. Can be either
html, json, or xml (default). This value overrides
the Accept header if both are present. |
| Request Headers |
| Accept |
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header. |
| Content-type |
The MIME type of the data in the request
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html. |
| Response Headers |
| Content-type |
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
|
Response
Upon success, MarkLogic Server returns status code 200 (OK), and the response
body contains the requested data.
Required Privileges
This operation requires the
manage-user role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
The structure of the output returned from
this REST API is as follows:
id
A host unique id (64-bit value).
name
The name of the Host
metaProperties of the view rather than the resource.
This is a complex structure with the following children:
uriThe path to the view.
current-timeThe timestamp for when the view was generated.
elapsed-timeThe time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-minThe timestamp for filtering out more recent
requests or transactions.
view-errorAn error limiting the data in the view.
This is a complex structure with the following children:
error-typeThe kind of error.
error-nameThe name of the error.
error-codeThe error identifier.
error-messageThe error text.
config-propertiesThe configuration characteristics of the host.
This is a complex structure with the following children:
host-mode
The mode of this host
host-mode-description
The description for this host mode
bind-port
The distributed protocol server socket bind internet port number.
connect-port
The distributed protocol client socket connect internet port number.
foreign-bind-port
The distributed protocol foreign server socket bind internet port number.
foreign-connect-port
The distributed protocol foreign client socket connect internet port number.
ssl-certificate-old
The old PEM encoded certificate for the host. If the 'file' attribute is
present, it is a file containing the PEM encoded certificate.
ssl-certificate-new
The new PEM encoded certificate for the host. If the 'file' attribute is
present, it is a file containing the PEM encoded certificate.
zone
Zone the host belongs to.
bootstrap-host
related-viewsA list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-viewA broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-typeThe kind of view.
view-nameThe name of the view.
view-uriThe path for the view.
Example
http://localhost:8002/manage/v2/hosts/myhost?view=config&format=json
==> Returns configuration information on the 'myhost' host, as JSON.
Copyright © 2025 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.